<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::Shark Class Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_shark.html">Shark</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_shark-members.html">List of all members</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::Shark Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Allows for querying compile settings at runtime. Provides the current command line arguments to the rest of the library.  
 <a href="classshark_1_1_shark.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_shark_8h_source.html">shark/Core/Shark.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_shark_1_1_version.html">Version</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models a version according to the major.minor.patch versioning scheme.  <a href="structshark_1_1_shark_1_1_version.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a468b025010bb4cbced92b7362f916d3a" id="r_a468b025010bb4cbced92b7362f916d3a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceshark.html#af6e9952baf657dc6e9e294bc3c8bcf09">BuildType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a468b025010bb4cbced92b7362f916d3a">buildType</a> ()</td></tr>
<tr class="memdesc:a468b025010bb4cbced92b7362f916d3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accesses the build type of the library.  <br /></td></tr>
<tr class="separator:a468b025010bb4cbced92b7362f916d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8942bfd1e10759b90f7d7efc9a884625" id="r_a8942bfd1e10759b90f7d7efc9a884625"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a8942bfd1e10759b90f7d7efc9a884625">hasOpenMp</a> ()</td></tr>
<tr class="memdesc:a8942bfd1e10759b90f7d7efc9a884625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries whether <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> has been compiled with OpenMP enabled.  <br /></td></tr>
<tr class="separator:a8942bfd1e10759b90f7d7efc9a884625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ca0b2788d4f82f18b5bece96508c068" id="r_a2ca0b2788d4f82f18b5bece96508c068"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a2ca0b2788d4f82f18b5bece96508c068">isDynamicLibrary</a> ()</td></tr>
<tr class="memdesc:a2ca0b2788d4f82f18b5bece96508c068"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries whether <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> has been compiled as dynamic library.  <br /></td></tr>
<tr class="separator:a2ca0b2788d4f82f18b5bece96508c068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f662426dc2bf5ede89bb5fc2c8dc46" id="r_ab9f662426dc2bf5ede89bb5fc2c8dc46"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#ab9f662426dc2bf5ede89bb5fc2c8dc46">isOfficialRelease</a> ()</td></tr>
<tr class="memdesc:ab9f662426dc2bf5ede89bb5fc2c8dc46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether this is an official <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> release.  <br /></td></tr>
<tr class="separator:ab9f662426dc2bf5ede89bb5fc2c8dc46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a620b111e1c1a195fa9f4f24c885fdc00" id="r_a620b111e1c1a195fa9f4f24c885fdc00"><td class="memTemplParams" colspan="2">template&lt;typename Stream &gt; </td></tr>
<tr class="memitem:a620b111e1c1a195fa9f4f24c885fdc00"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a620b111e1c1a195fa9f4f24c885fdc00">info</a> (Stream &amp;s)</td></tr>
<tr class="memdesc:a620b111e1c1a195fa9f4f24c885fdc00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints information about the <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> Machine Learning Library to the supplied stream.  <br /></td></tr>
<tr class="separator:a620b111e1c1a195fa9f4f24c885fdc00"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a6fdaded1b30405d032656495bf28ad3d" id="r_a6fdaded1b30405d032656495bf28ad3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a6fdaded1b30405d032656495bf28ad3d">Shark</a> ()</td></tr>
<tr class="separator:a6fdaded1b30405d032656495bf28ad3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f8920723fe5cc9956c6f184178dddca" id="r_a6f8920723fe5cc9956c6f184178dddca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a6f8920723fe5cc9956c6f184178dddca">Shark</a> (const <a class="el" href="classshark_1_1_shark.html">Shark</a> &amp;shark)</td></tr>
<tr class="separator:a6f8920723fe5cc9956c6f184178dddca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f03a2c641c67f83775d255d1e3b02d3" id="r_a6f03a2c641c67f83775d255d1e3b02d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_shark.html">Shark</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shark.html#a6f03a2c641c67f83775d255d1e3b02d3">operator=</a> (const <a class="el" href="classshark_1_1_shark.html">Shark</a> &amp;rhs)</td></tr>
<tr class="separator:a6f03a2c641c67f83775d255d1e3b02d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Allows for querying compile settings at runtime. Provides the current command line arguments to the rest of the library. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00169">169</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6fdaded1b30405d032656495bf28ad3d" name="a6fdaded1b30405d032656495bf28ad3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fdaded1b30405d032656495bf28ad3d">&#9670;&#160;</a></span>Shark() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::Shark::Shark </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a6f8920723fe5cc9956c6f184178dddca" name="a6f8920723fe5cc9956c6f184178dddca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f8920723fe5cc9956c6f184178dddca">&#9670;&#160;</a></span>Shark() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::Shark::Shark </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classshark_1_1_shark.html">Shark</a> &amp;&#160;</td>
          <td class="paramname"><em>shark</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a468b025010bb4cbced92b7362f916d3a" name="a468b025010bb4cbced92b7362f916d3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468b025010bb4cbced92b7362f916d3a">&#9670;&#160;</a></span>buildType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="namespaceshark.html#af6e9952baf657dc6e9e294bc3c8bcf09">BuildType</a> shark::Shark::buildType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Accesses the build type of the library. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00226">226</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_shark.html#a620b111e1c1a195fa9f4f24c885fdc00">info()</a>.</p>

</div>
</div>
<a id="a8942bfd1e10759b90f7d7efc9a884625" name="a8942bfd1e10759b90f7d7efc9a884625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8942bfd1e10759b90f7d7efc9a884625">&#9670;&#160;</a></span>hasOpenMp()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool shark::Shark::hasOpenMp </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Queries whether <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> has been compiled with OpenMP enabled. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00233">233</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_shark.html#a620b111e1c1a195fa9f4f24c885fdc00">info()</a>.</p>

</div>
</div>
<a id="a620b111e1c1a195fa9f4f24c885fdc00" name="a620b111e1c1a195fa9f4f24c885fdc00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a620b111e1c1a195fa9f4f24c885fdc00">&#9670;&#160;</a></span>info()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Stream &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void shark::Shark::info </td>
          <td>(</td>
          <td class="paramtype">Stream &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints information about the <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> Machine Learning Library to the supplied stream. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00255">255</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_shark.html#a468b025010bb4cbced92b7362f916d3a">buildType()</a>, <a class="el" href="namespaceshark.html#af6e9952baf657dc6e9e294bc3c8bcf09ac3d1a0b6663f578ac967aed503ca70c3">shark::DEBUG_BUILD_TYPE</a>, <a class="el" href="classshark_1_1_shark.html#a8942bfd1e10759b90f7d7efc9a884625">hasOpenMp()</a>, <a class="el" href="classshark_1_1_shark.html#a2ca0b2788d4f82f18b5bece96508c068">isDynamicLibrary()</a>, <a class="el" href="classshark_1_1_shark.html#ab9f662426dc2bf5ede89bb5fc2c8dc46">isOfficialRelease()</a>, <a class="el" href="structshark_1_1_shark_1_1_version.html#aaf28eda93dd2d3cfd269fe7f05fd3139">shark::Shark::Version&lt; major, minor, patch &gt;::MAJOR()</a>, <a class="el" href="structshark_1_1_shark_1_1_version.html#a06fb8113023fbda0bff520dc0d7df574">shark::Shark::Version&lt; major, minor, patch &gt;::MINOR()</a>, <a class="el" href="structshark_1_1_shark_1_1_version.html#acc94927f9746196f87cc94532b9387d5">shark::Shark::Version&lt; major, minor, patch &gt;::PATCH()</a>, and <a class="el" href="namespaceshark.html#af6e9952baf657dc6e9e294bc3c8bcf09a002a5c9855aa975d5221f98fdff5c58a">shark::RELEASE_BUILD_TYPE</a>.</p>

<p class="reference">Referenced by <a class="el" href="_hello_world_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>

</div>
</div>
<a id="a2ca0b2788d4f82f18b5bece96508c068" name="a2ca0b2788d4f82f18b5bece96508c068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ca0b2788d4f82f18b5bece96508c068">&#9670;&#160;</a></span>isDynamicLibrary()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool shark::Shark::isDynamicLibrary </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Queries whether <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> has been compiled as dynamic library. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00240">240</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_shark.html#a620b111e1c1a195fa9f4f24c885fdc00">info()</a>.</p>

</div>
</div>
<a id="ab9f662426dc2bf5ede89bb5fc2c8dc46" name="ab9f662426dc2bf5ede89bb5fc2c8dc46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f662426dc2bf5ede89bb5fc2c8dc46">&#9670;&#160;</a></span>isOfficialRelease()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool shark::Shark::isOfficialRelease </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Checks whether this is an official <a class="el" href="classshark_1_1_shark.html" title="Allows for querying compile settings at runtime. Provides the current command line arguments to the r...">Shark</a> release. </p>

<p class="definition">Definition at line <a class="el" href="_shark_8h_source.html#l00247">247</a> of file <a class="el" href="_shark_8h_source.html">Shark.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_shark.html#a620b111e1c1a195fa9f4f24c885fdc00">info()</a>.</p>

</div>
</div>
<a id="a6f03a2c641c67f83775d255d1e3b02d3" name="a6f03a2c641c67f83775d255d1e3b02d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f03a2c641c67f83775d255d1e3b02d3">&#9670;&#160;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_shark.html">Shark</a> &amp; shark::Shark::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classshark_1_1_shark.html">Shark</a> &amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Core/<a class="el" href="_shark_8h_source.html">Shark.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
